Minimal reproducible code draft #73
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Merge branch 'minimal-reproducible-code-draft' of github.com:carpentries-incubator/R-help-reprexes into minimal-reproducible-code-draft # Conflicts: # episodes/5-minimal-reproducible-code.Rmd
Thank you!Thank you for your pull request 😃 🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}. If you have files that automatically render output (e.g. R Markdown), then you should check for the following:
Rendered Changes🔍 Inspect the changes: https://github.com/carpentries-incubator/R-help-reprexes/compare/md-outputs..md-outputs-PR-73 The following changes were observed in the rendered markdown documents: What does this mean?If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible. This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation. ⏱️ Updated at 2024-11-23 01:36:51 +0000 |
peterlaurin
approved these changes
Nov 23, 2024
github-actions bot
pushed a commit
that referenced
this pull request
Nov 23, 2024
Auto-generated via `{sandpaper}`
Source : d8b86da
Branch : main
Author : peterlaurin <[email protected]>
Time : 2024-11-23 01:38:06 +0000
Message : Merge pull request #73 from carpentries-incubator/minimal-reproducible-code-draft
Minimal reproducible code draft -- Resolved discrepancy in yaml with md and Rmd
github-actions bot
pushed a commit
that referenced
this pull request
Nov 23, 2024
Auto-generated via `{sandpaper}`
Source : d7c2a92
Branch : md-outputs
Author : GitHub Actions <[email protected]>
Time : 2024-11-23 01:41:12 +0000
Message : markdown source builds
Auto-generated via `{sandpaper}`
Source : d8b86da
Branch : main
Author : peterlaurin <[email protected]>
Time : 2024-11-23 01:38:06 +0000
Message : Merge pull request #73 from carpentries-incubator/minimal-reproducible-code-draft
Minimal reproducible code draft -- Resolved discrepancy in yaml with md and Rmd
github-actions bot
pushed a commit
that referenced
this pull request
Nov 26, 2024
Auto-generated via `{sandpaper}`
Source : d8b86da
Branch : main
Author : peterlaurin <[email protected]>
Time : 2024-11-23 01:38:06 +0000
Message : Merge pull request #73 from carpentries-incubator/minimal-reproducible-code-draft
Minimal reproducible code draft -- Resolved discrepancy in yaml with md and Rmd
github-actions bot
pushed a commit
that referenced
this pull request
Nov 26, 2024
Auto-generated via `{sandpaper}`
Source : a832cb7
Branch : md-outputs
Author : GitHub Actions <[email protected]>
Time : 2024-11-26 01:19:26 +0000
Message : markdown source builds
Auto-generated via `{sandpaper}`
Source : d8b86da
Branch : main
Author : peterlaurin <[email protected]>
Time : 2024-11-23 01:38:06 +0000
Message : Merge pull request #73 from carpentries-incubator/minimal-reproducible-code-draft
Minimal reproducible code draft -- Resolved discrepancy in yaml with md and Rmd
github-actions bot
pushed a commit
that referenced
this pull request
Dec 3, 2024
Auto-generated via `{sandpaper}`
Source : a832cb7
Branch : md-outputs
Author : GitHub Actions <[email protected]>
Time : 2024-11-26 01:19:26 +0000
Message : markdown source builds
Auto-generated via `{sandpaper}`
Source : d8b86da
Branch : main
Author : peterlaurin <[email protected]>
Time : 2024-11-23 01:38:06 +0000
Message : Merge pull request #73 from carpentries-incubator/minimal-reproducible-code-draft
Minimal reproducible code draft -- Resolved discrepancy in yaml with md and Rmd
xortizross
added a commit
that referenced
this pull request
Dec 3, 2024
commit 04fc52c Merge: 66501ae ff995ea Author: Xochitl Ortiz-Ross <[email protected]> Date: Tue Dec 3 14:04:57 2024 -0800 Merge pull request #79 from carpentries-incubator/peter_edits changed relative path to load data commit ff995ea Author: peterlaurin <[email protected]> Date: Tue Dec 3 14:01:18 2024 -0800 changed relative path to load data commit 66501ae Merge: b2ef676 c7d87b9 Author: Xochitl Ortiz-Ross <[email protected]> Date: Tue Dec 3 13:34:33 2024 -0800 Merge pull request #78 from carpentries-incubator/peter_edits added identify the problem episode for review, Dec2024. Changed to Rm… commit c7d87b9 Author: peterlaurin <[email protected]> Date: Tue Dec 3 12:44:26 2024 -0800 removed open tag for carpentries commit d419691 Author: peterlaurin <[email protected]> Date: Tue Dec 3 12:35:55 2024 -0800 fixed further bugs commit ad93365 Author: peterlaurin <[email protected]> Date: Tue Dec 3 12:19:41 2024 -0800 fixed some last-minute R bugs commit b2ef676 Merge: d8b86da d82aa3b Author: peterlaurin <[email protected]> Date: Tue Dec 3 12:04:53 2024 -0800 Merge pull request #77 from carpentries-incubator/xochitl_edits small edits commit c1af304 Merge: 97eed2e d8b86da Author: peterlaurin <[email protected]> Date: Tue Dec 3 12:01:33 2024 -0800 Merge branch 'main' into peter_edits commit 97eed2e Author: peterlaurin <[email protected]> Date: Tue Dec 3 11:41:51 2024 -0800 changed config to allow Rmd file for Peter's episode to run commit 3a8d5b8 Author: peterlaurin <[email protected]> Date: Tue Dec 3 11:25:36 2024 -0800 added identify the problem episode for review, Dec2024. Changed to Rmd to run R. commit d8b86da Merge: 96901a7 782e862 Author: peterlaurin <[email protected]> Date: Fri Nov 22 17:38:06 2024 -0800 Merge pull request #73 from carpentries-incubator/minimal-reproducible-code-draft Minimal reproducible code draft -- Resolved discrepancy in yaml with md and Rmd commit 782e862 Merge: 761d64f 96901a7 Author: peterlaurin <[email protected]> Date: Fri Nov 22 17:32:47 2024 -0800 Merge branch 'main' into minimal-reproducible-code-draft commit 96901a7 Merge: 5a23b4b fa15716 Author: peterlaurin <[email protected]> Date: Fri Nov 22 17:30:07 2024 -0800 Merge pull request #65 from carpentries-incubator/kaijagahm-patch-3 Update pull_request_template.md commit 761d64f Author: Kaija Gahm <[email protected]> Date: Fri Nov 22 17:00:33 2024 -0800 Draft entire episode except for exercise content commit 7ce1de3 Author: Kaija Gahm <[email protected]> Date: Fri Nov 22 10:58:19 2024 -0800 fixed merge conflicts commit 5a23b4b Merge: 2335e86 ea9aecf Author: Kaija Gahm <[email protected]> Date: Wed Nov 6 13:58:13 2024 -0800 Merge pull request #69 from carpentries-incubator/xochitl_edits Xochitl edits commit 449d69f Merge: 5c85579 5210f72 Author: Kaija Gahm <[email protected]> Date: Wed Oct 23 14:57:12 2024 -0700 fixed merge conflict Merge branch 'minimal-reproducible-code-draft' of github.com:carpentries-incubator/R-help-reprexes into minimal-reproducible-code-draft # Conflicts: # episodes/5-minimal-reproducible-code.Rmd commit 5c85579 Author: Kaija Gahm <[email protected]> Date: Wed Oct 23 14:29:36 2024 -0700 15:00 end work session commit 5210f72 Author: Kaija Gahm <[email protected]> Date: Wed Oct 23 14:29:36 2024 -0700 2:30 end work session commit 3ccd70e Author: Kaija Gahm <[email protected]> Date: Wed Oct 23 14:03:56 2024 -0700 sketching more exercises. reordered road map slightly. commit 1817002 Author: Kaija Gahm <[email protected]> Date: Thu Oct 17 13:16:40 2024 -0700 remembered ??fun shortcut for searching commit 2265911 Author: Kaija Gahm <[email protected]> Date: Wed Oct 16 15:00:23 2024 -0700 First draft of lesson text for the first part of the road map commit c73f662 Author: Kaija Gahm <[email protected]> Date: Wed Oct 16 14:39:05 2024 -0700 full episode outline commit d95d7cc Author: Kaija Gahm <[email protected]> Date: Wed Oct 16 14:26:29 2024 -0700 Updated LOs for Ep5; moved {reprex} to Ep6 commit 8c33a45 Author: Kaija Gahm <[email protected]> Date: Wed Oct 16 14:13:58 2024 -0700 Moved progress from last week to .Rmd from .md commit fa15716 Author: Kaija Gahm <[email protected]> Date: Wed Oct 2 14:36:28 2024 -0700 Update pull_request_template.md Just a simple update for our own use commit 2ec2b16 Author: Kaija Gahm <[email protected]> Date: Wed Oct 2 14:03:26 2024 -0700 First crack at narrative and a first exercise commit dcb0d48 Author: Kaija Gahm <[email protected]> Date: Wed Oct 2 13:27:14 2024 -0700 added LOs from google doc, and corresponding questions
xortizross
reviewed
Dec 4, 2024
| --- | ||
|
|
||
| ::: questions | ||
| - Which part of my code is causing an error message or an incorrect result? |
There was a problem hiding this comment.
"...is causing the problem?" -- a way to shorten the question?
There was a problem hiding this comment.
Ooh yes I like this.
| - Which part of my code is causing an error message or an incorrect result? | ||
| - I want to make my code minimal, but where do I even start? | ||
| - How do I make non-reproducible code reproducible? | ||
| - How do I tell whether a code snippet is reproducible or not? |
There was a problem hiding this comment.
I feel like this should go before the previous one
| ::: questions | ||
| - Which part of my code is causing an error message or an incorrect result? | ||
| - I want to make my code minimal, but where do I even start? | ||
| - How do I make non-reproducible code reproducible? |
There was a problem hiding this comment.
"How do I make my code reproducible?"
| - Identify the step that is generating the error | ||
| - Implement a stepwise approach to make minimal code | ||
| - Edit a piece of code to make it reproducible | ||
| - Evaluate whether a piece of code is reproducible as is or not. If not, identify what is missing. |
There was a problem hiding this comment.
Again, I feel like this should go before the previous one... (first figure out whether it is reproducible, then fix it to make it so)
| - How do I tell whether a code snippet is reproducible or not? | ||
| ::: | ||
|
|
||
| ::: objectives |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Full draft of the minimal reproducible code lesson. Includes full lesson structure.
Notes:
I dumped a giant script at the beginning that includes the code in the researcher narrative up through the part that was assigned to this episode. I realize this is overwhelming and gross, and we can discuss changes to it.
Critically, this is still missing content for the exercises, and that's largely because the script itself does not contain enough errors. Need to introduce some errors into the script, especially in the later portions (modeling, plotting, answering research questions) so that we can then refer to those in the lesson.
Time estimates are probably way off.
@peterlaurin and @xortizross there are some spots indicated here for you to add references back to your own episodes